
package storage

import (
	"fmt"
	"os"
	"time"

	"go.etcd.io/etcd/raft/v3/raftpb"
	"go.etcd.io/etcd/server/v3/config"
	"go.etcd.io/etcd/server/v3/etcdserver/api/snap"
	"go.etcd.io/etcd/server/v3/storage/backend"
	"go.etcd.io/etcd/server/v3/storage/schema"

	"go.uber.org/zap"
)

func newBackend(cfg config.ServerConfig, hooks backend.Hooks) backend.Backend {
	bcfg := backend.DefaultBackendConfig()
	bcfg.Path = cfg.BackendPath()
	bcfg.UnsafeNoFsync = cfg.UnsafeNoFsync
	if cfg.BackendBatchLimit != 0 {
		bcfg.BatchLimit = cfg.BackendBatchLimit
		if cfg.Logger != nil {
			cfg.Logger.Info("setting backend batch limit", zap.Int("batch limit", cfg.BackendBatchLimit))
		}
	}
	if cfg.BackendBatchInterval != 0 {
		bcfg.BatchInterval = cfg.BackendBatchInterval
		if cfg.Logger != nil {
			cfg.Logger.Info("setting backend batch interval", zap.Duration("batch interval", cfg.BackendBatchInterval))
		}
	}
	bcfg.BackendFreelistType = cfg.BackendFreelistType
	bcfg.Logger = cfg.Logger
	if cfg.QuotaBackendBytes > 0 && cfg.QuotaBackendBytes != DefaultQuotaBytes {
		// 允许超出配额10%解除防护
		bcfg.MmapSize = uint64(cfg.QuotaBackendBytes + cfg.QuotaBackendBytes/10)
	}
	bcfg.Mlock = cfg.ExperimentalMemoryMlock
	bcfg.Hooks = hooks
	return backend.New(bcfg)
}

// OpenSnapshotBackend将快照数据库重命名为当前etcd数据库并将其打开。
// 重建新的 B ackend 实例的 openSnapshotBackend （）函数
func OpenSnapshotBackend(cfg config.ServerConfig, ss *snap.Snapshotter, snapshot raftpb.Snapshot, hooks *BackendHooks) (backend.Backend, error) {
	// 根据快照元数据查找对」丑的 BoltDB 数据库丈件，
	snapPath, err := ss.DBFilePath(snapshot.Metadata.Index)
	if err != nil {
		return nil, fmt.Errorf("failed to find database snapshot file (%v)", err)
	}
	// 将可用的 BoltDB 数据库文件移动到指定的目录中
	if err := os.Rename(snapPath, cfg.BackendPath()); err != nil {
		return nil, fmt.Errorf("failed to rename database snapshot file (%v)", err)
	}
	return OpenBackend(cfg, hooks), nil	// 新建 Backend 实例
}

//  openBackend（）函 数，在该函数中会启动一个后台 g oroutine 完成 Backend 实例的初始化，
func OpenBackend(cfg config.ServerConfig, hooks backend.Hooks) backend.Backend {
	fn := cfg.BackendPath()

	now, beOpened := time.Now(), make(chan backend.Backend)
	go func() {	// 启动一个后台 goroutine 并将新建的 Backend 实例写入 beOpened 通道中
		beOpened <- newBackend(cfg, hooks)	// 新建 Backend 实例
	}()

	select {
	case be := <-beOpened:
		cfg.Logger.Info("opened backend db", zap.String("path", fn), zap.Duration("took", time.Since(now)))
		return be

	case <-time.After(10 * time.Second):	// 初始化 Backend 实例超时，会输出日志
		cfg.Logger.Info(
			"db file is flocked by another process, or taking too long",
			zap.String("path", fn),
			zap.Duration("took", time.Since(now)),
		)
	}

	return <-beOpened	// 阻塞等待 Backend 实例初始化完成
}

// v3 存储的恢复，该过程是在 recoverS napshotBackend（）函 数中实现的 ，其中 会检测前面
// 创建的 Backend 实例是否可用（即包含了 快照数据所包含的全部 Entry 记录），如果可用则继续
// 使用该 Backend 实例，如果不可用则根据快照的元数据查找可用的 BoltDB 数据库文件，井创
// 建新的 Backend 实例 。其中查找可用的 BoltDB 数据库文件和新建 Backend 实例等操作是在
// openSnapshotBackend（） 函数中完成的
func RecoverSnapshotBackend(cfg config.ServerConfig, oldbe backend.Backend, snapshot raftpb.Snapshot, beExist bool, hooks *BackendHooks) (backend.Backend, error) {
	consistentIndex := uint64(0)
	if beExist {
		consistentIndex, _ = schema.ReadConsistentIndex(oldbe.BatchTx())
	}
	if snapshot.Metadata.Index <= consistentIndex {
		return oldbe, nil	// 若当前使用的 Backend 实例可用，则直接返回
	}
	oldbe.Close()	// 旧 Backend 实例不可用，则关 闭旧的 Backend 实例 ，并重建新的 Backend 实例
	return OpenSnapshotBackend(cfg, snap.New(cfg.Logger, cfg.SnapDir()), snapshot, hooks)
}
